Purpose

Retrieves the binary copy of the specified Key. It is necessary to specify the product version - current version or previous version. The retrieved code does not include an installer.

Signature

Method name: partner10.retrieveKey

Parameters

# Type Description
1 struct AuthInfo requesting party authentication information
2 string number of a key
3 boolean previous version

Returns

Field Type Description
resultCode int code for command execution result (see below)
resultDesc string textual description of command execution result (see below)
keyNumber string number of a retrieved key
key base64 body of a key

Result Codes

resultCode resultDesc
100 <key number> has been successfully retrieved
200 Client authorization failed
201 Access to this method is denied
202 Access to this object is denied
220 Key <key number> is not found
221 License key <key number> is marked as problem
222 License key <key number> is terminated
223 License key <key number> is not activated
224 License key <key number> is not exportable
227 License key <key number> is not exportable in previous version
228 License key <key number> is expired
300 Internal error, please try after some time
400 Incorrect authorization info format
410 Incorrect key number format: “<key number>”

XML Examples

Request message

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
   <methodName>partner10.retrieveKey</methodName>
   <params>
      <param>
         <value>
            <struct>
               <member>
                  <name>login</name>
                  <value>
                     <string>API_LOGIN</string>
                  </value>
               </member>
               <member>
                  <name>password</name>
                  <value>
                     <string>API_PASSWORD</string>
                  </value>
               </member>
            </struct>
         </value>
      </param>
      <param>
         <value>
            <string>PLSK.00123456.0000</string>
         </value>
      </param>
      <param>
         <value>
            <boolean>1</boolean>
         </value>
      </param>
   </params>
</methodCall>

Response message

<?xml version="1.0"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>resultCode</name>
            <value>
              <int>100</int>
            </value>
          </member>
          <member>
            <name>key</name>
            <value>
              <base64>a2V5LWJvZHk=</base64>
            </value>
          </member>
          <member>
            <name>resultDesc</name>
            <value>PLSK.00123456.0001 has been successfully retrieved</value>
          </member>
          <member>
            <name>keyNumber</name>
            <value>PLSK.00123456.0001</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>